Vcenter Deployment Upgrade UpgradeSpec

Vcenter Deployment Upgrade UpgradeSpec
Vcenter Deployment Upgrade UpgradeSpec

This schema is deprecated as of vSphere API 9.0.0.0.

The Vcenter Deployment Upgrade UpgradeSpec schema contains information used to configure the appliance upgrade.

This schema was added in vSphere API 6.7.

JSON Example
{
    "source_appliance": {
        "hostname": "string",
        "https_port": 0,
        "ssl_thumbprint": "string",
        "ssl_certificate": "string",
        "ssl_verify": false,
        "sso_admin_username": "string",
        "sso_admin_password": "string",
        "root_password": "string",
        "ssh_verify": false,
        "ssh_thumbprint": "string"
    },
    "source_location": {
        "hostname": "string",
        "https_port": 0,
        "ssl_thumbprint": "string",
        "ssl_certificate": "string",
        "ssl_verify": false,
        "username": "string",
        "password": "string"
    },
    "history": {
        "data_set": "string",
        "defer_import": false
    },
    "vcsa_embedded": {
        "ceip_enabled": false
    },
    "psc": {
        "ceip_enabled": false
    },
    "replicated_partner_hostname": "string",
    "export_directory": "string",
    "auto_answer": false,
    "skip_products_prechecks": false
}
source_appliance
Required

This property is deprecated as of vSphere API 9.0.0.0.

Source appliance spec.

This property was added in vSphere API 6.7.

source_location
Required

This property is deprecated as of vSphere API 9.0.0.0.

Source location spec.

This property was added in vSphere API 6.7.

history
Optional

This property is deprecated as of vSphere API 9.0.0.0.

Determines how vCenter history will be migrated during the upgrade process. vCenter history consists of:

  • Statistics
  • Events
  • Tasks By default only core data will be migrated. Use this spec to define which part of vCenter history data will be migrated and when.

This property was added in vSphere API 6.7.

If missing or null, only core database content will be migrated.

vcsa_embedded
Optional

This property is deprecated as of vSphere API 9.0.0.0.

Information that are specific to this embedded vCenter Server.

This property was added in vSphere API 6.7.

If missing or null, ceip_enabled for embedded vcenter server upgrade will default to enabled.

psc
Optional

This property is deprecated as of vSphere API 9.0.0.0.

Information that are specific to this Platform Services Controller.

This property was added in vSphere API 6.7.

If missing or null, ceip_enabled for psc upgrade will default to enabled.

string
replicated_partner_hostname
Optional

This property is deprecated as of vSphere API 9.0.0.0.

Applicable only if the convergence is in progress and at least one of the nodes is already upgraded. Set the replication partner for the currently upgraded node and provide the value of any previously converged upgraded node host name as either IP address or FQDN. If missing or null, when the upgrade finishes, the vCenter Server external Platform Services Controller are converged into the vCenter Server appliance.

This property was added in vSphere API 8.0.3.0.

This property is optional because it was added in a newer version than its parent node.

string
export_directory
Optional

This property is deprecated as of vSphere API 9.0.0.0.

Use the option to provide export directory information during vCenter Server upgrade.

This property was added in vSphere API 8.0.3.0.

If missing or null, will default to seat directory.

boolean
auto_answer
Optional

This property is deprecated as of vSphere API 9.0.0.0.

Use the default option for any questions that may come up during appliance configuration.

This property was added in vSphere API 6.7.

If missing or null, will default to false.

boolean
skip_products_prechecks
Optional

This property is deprecated as of vSphere API 9.0.0.0.

Use the option to skip products interoperability checks during upgrade prechecks.

This property was added in vSphere API 8.0.3.0.

If missing or null, will default to false.